<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="OAuthRequest,com.photobucket.webapi.oauth.OAuthRequest,fault,file,method,needsLogin,parameterString,result,token,url,urlVariables,addParameter,getURLRequest,sortByKey" name="keywords">
<title>com.photobucket.webapi.oauth.OAuthRequest</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'OAuthRequest - Photobucket Open API AS3 Client Library';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Photobucket Open API AS3 Client Library Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?com/photobucket/webapi/oauth/OAuthRequest.html&amp;com/photobucket/webapi/oauth/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;OAuthRequest</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class OAuthRequest"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.photobucket.webapi.oauth</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class OAuthRequest</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implements</td><td><a href="IOAuthRequest.html">IOAuthRequest</a></td>
</tr>
</table>
<p></p>
  OauthRequest
  
  Container for all parameters nessecary to make an OAuthRequest and the log nessecary to sort the parameters correctly.
  <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#fault">fault</a> : Function<div class="summaryTableDescription">
    Function to be called on an unsucessful result from the service or a transmission error.</div>
</td><td class="summaryTableOwnerCol">OAuthRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#file">file</a> : FileReference<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">OAuthRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#method">method</a> : String<div class="summaryTableDescription">
    The HTTP method of the request.</div>
</td><td class="summaryTableOwnerCol">OAuthRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#needsLogin">needsLogin</a> : Boolean<div class="summaryTableDescription">
    This flag sets if request needs to be signed with the oauth_token_secret
    this is provided as for most APIs it requires extra work to verify the 
    user has authorized the consumer.</div>
</td><td class="summaryTableOwnerCol">OAuthRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#parameterString">parameterString</a> : String<div class="summaryTableDescription">[read-only]
   Parameter string that can be used as part of the oauth base string 
   </div>
</td><td class="summaryTableOwnerCol">OAuthRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#result">result</a> : Function<div class="summaryTableDescription">
   Function to be called on sucessful result from the service.</div>
</td><td class="summaryTableOwnerCol">OAuthRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#token">token</a> : Object<div class="summaryTableDescription">
   Simple Token Object to pass information with the request 
   </div>
</td><td class="summaryTableOwnerCol">OAuthRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#url">url</a> : String<div class="summaryTableDescription">
   URL of the Request this should not include GET parameters
   </div>
</td><td class="summaryTableOwnerCol">OAuthRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#urlVariables">urlVariables</a> : URLVariables<div class="summaryTableDescription">[read-only]
   Returns a URLVariables object of request in it's current state.</div>
</td><td class="summaryTableOwnerCol">OAuthRequest</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#OAuthRequest()">OAuthRequest</a>()</div>
<div class="summaryTableDescription">
   Constructor
   
   Basically does nothing
   </div>
</td><td class="summaryTableOwnerCol">OAuthRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addParameter()">addParameter</a>(key:String, value:String):void</div>
<div class="summaryTableDescription">
   Adds a parameter to the request and they should be key value pairs of strings.</div>
</td><td class="summaryTableOwnerCol">OAuthRequest</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getURLRequest()">getURLRequest</a>():URLRequest</div>
<div class="summaryTableDescription">
   Creates a URLRequest object based on OAuthRequest object 
   </div>
</td><td class="summaryTableOwnerCol">OAuthRequest</td>
</tr>
</table>
</div>
<a name="protectedMethodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Protected Methods</div>
<table id="summaryTableProtectedMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#sortByKey()">sortByKey</a>():void</div>
<div class="summaryTableDescription">
   Sorts the parameters according to the oauth spec and prior to getting the parameter string 
   does not need to be called out side of the OAuthBaseService for making of the parameter string
   </div>
</td><td class="summaryTableOwnerCol">OAuthRequest</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="fault"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">fault</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>fault:Function</code>&nbsp;&nbsp;[read-write]<p>
    Function to be called on an unsucessful result from the service or a transmission error.  This can be a closure 
    so you can clean up some messy event handler code.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get fault():Function</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set fault(value:Function):void</code>
<br>
</div>
<a name="file"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">file</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>file:FileReference</code>&nbsp;&nbsp;[read-write]<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get file():FileReference</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set file(value:FileReference):void</code>
<br>
</div>
<a name="method"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">method</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>method:String</code>&nbsp;&nbsp;[read-write]<p>
    The HTTP method of the request.  
    </p><p>The default value is <code>GET</code>.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get method():String</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set method(value:String):void</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../oauth/OAuthRequestMethod.html" target="">com.photobucket.webapi.oauth.OAuthRequestMethod</a>
</div>
</div>
<a name="needsLogin"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">needsLogin</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>needsLogin:Boolean</code>&nbsp;&nbsp;[read-write]<p>
    This flag sets if request needs to be signed with the oauth_token_secret
    this is provided as for most APIs it requires extra work to verify the 
    user has authorized the consumer.  No need to make the API do exta work.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get needsLogin():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set needsLogin(value:Boolean):void</code>
<br>
</div>
<a name="parameterString"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">parameterString</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>parameterString:String</code>&nbsp;&nbsp;[read-only]<p>
   Parameter string that can be used as part of the oauth base string 
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get parameterString():String</code>
<br>
</div>
<a name="result"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">result</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>result:Function</code>&nbsp;&nbsp;[read-write]<p>
   Function to be called on sucessful result from the service. This can be a closure that be used to clean up
   the async behavior of a process
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get result():Function</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set result(value:Function):void</code>
<br>
</div>
<a name="token"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">token</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>token:Object</code>&nbsp;&nbsp;[read-write]<p>
   Simple Token Object to pass information with the request 
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get token():Object</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set token(value:Object):void</code>
<br>
</div>
<a name="url"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">url</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>url:String</code>&nbsp;&nbsp;[read-write]<p>
   URL of the Request this should not include GET parameters
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get url():String</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set url(value:String):void</code>
<br>
</div>
<a name="urlVariables"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">urlVariables</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>urlVariables:URLVariables</code>&nbsp;&nbsp;[read-only]<p>
   Returns a URLVariables object of request in it's current state.  This can be added to URLRequest object's
   data property in order to sign it. 
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get urlVariables():URLVariables</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="OAuthRequest()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">OAuthRequest</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function OAuthRequest()</code><p>
   Constructor
   
   Basically does nothing
   </p></div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="addParameter()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addParameter</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function addParameter(key:String, value:String):void</code><p>
   Adds a parameter to the request and they should be key value pairs of strings.  It is not recommeded that 
   these be escaped in any way prior to being added to the request.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">key</span>:String</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:String</code></td>
</tr>
</table>
</div>
<a name="getURLRequest()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getURLRequest</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function getURLRequest():URLRequest</code><p>
   Creates a URLRequest object based on OAuthRequest object 
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>URLRequest</code></td>
</tr>
</table>
</div>
<a name="sortByKey()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">sortByKey</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected function sortByKey():void</code><p>
   Sorts the parameters according to the oauth spec and prior to getting the parameter string 
   does not need to be called out side of the OAuthBaseService for making of the parameter string
   </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
